Skip to main content

Retrieve Smart Hands support plans

Request

This method retrieves all the available Smart Hands support plans and its remaining minutes to consume for a user with Smart Hands support plans viewing permission.

Security
BearerAuth
Query
accountNumbersArray of strings

List of accounts to be filtered

ibxsArray of strings

List of IBXs to be filtered

offsetinteger, >= 0

Use offset to control the number of records to be skipped in the response.

Default:0
limitinteger, [ 1 .. 200 ]

Use limit to restrict the number of records in the response.

Default:10
sortsArray of strings

Sort the users in the response in a particular order. For descending order, prefix the field name with '-'.

planIdsArray of strings, [ 1 .. 10 ] items

List of PlanIds to be filtered

Payload
// No request payload

Responses

Ok

Bodyapplication/json
dataArray of objects(support plan details response)
paginationobject(pagination)

Pagination

Response
{ "data": [ { … }, { … }, { … } ], "pagination": { "offset": 0, "limit": 25, "total": 100, "next": "/supportPlans?offset=25&limit=25", "previous": "/supportPlans?offset=0&limit=25" } }
Was this page helpful?